Skip to content

[WIP] feature: access logs in ui #10758

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 9 commits into from
Closed

[WIP] feature: access logs in ui #10758

wants to merge 9 commits into from

Conversation

shwstppr
Copy link
Contributor

@shwstppr shwstppr commented Apr 21, 2025 •
edited
Loading

Description

WIP. More details to be added

This feature enables administrators to view management server logs directly in the UI through a dedicated API call. It leverages a Netty-based websocket server to stream logs in real time, offering an efficient way to monitor and debug server operations. Note that the plugin is disabled by default and must be enabled manually.

Types of changes

  • Breaking change (fix or feature that would cause existing functionality to change)
  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Enhancement (improves an existing feature and functionality)
  • Cleanup (Code refactoring and cleanup, that may add test cases)
  • build/CI
  • test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

  • Major
  • Minor

Bug Severity

  • BLOCKER
  • Critical
  • Major
  • Minor
  • Trivial

Screenshots (if appropriate):

Logs-UI-Demo.mp4

How Has This Been Tested?

How did you try to break this feature and the system with this change?

@codecov Codecov
Copy link

codecov bot commented Apr 21, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.00%. Comparing base (6fdaf51) to head (70c0f71).
Report is 9 commits behind head on main.

Additional details and impacted files 
@@              Coverage Diff              @@
##               main   #10758       +/-   ##
=============================================
- Coverage     16.41%        0   -16.42%     
=============================================
  Files          5702        0     -5702     
  Lines        503405        0   -503405     
  Branches      60976        0    -60976     
=============================================
- Hits          82626        0    -82626     
+ Misses       411594        0   -411594     
+ Partials       9185        0     -9185
Flag Coverage Δ
uitests ?
unittests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@bernardodemarco bernardodemarco self-requested a review April 21, 2025 18:05
shwstppr added 5 commits April 22, 2025 03:05
@shwstppr
api,server,schema,plugin,client: logs web server
8e484cd 
This feature enables administrators to view management server logs directly in the UI through a dedicated API call. It leverages a Netty-based websocket server to stream logs in real time, offering an efficient way to monitor and debug server operations. Note that the plugin is disabled by default and must be enabled manually.

Signed-off-by: Abhishek Kumar <[email protected]>
@shwstppr
config: fix ManagementServer scope
316fdbc 
Signed-off-by: Abhishek Kumar <[email protected]>
@shwstppr
ui fixes
87bcafa 
Signed-off-by: Abhishek Kumar <[email protected]>
@shwstppr
fix lint
c4e354c 
Signed-off-by: Abhishek Kumar <[email protected]>
@shwstppr
fix test
58c0d36 
Signed-off-by: Abhishek Kumar <[email protected]>
@github-actions GitHub Actions
Copy link

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@github-actions GitHub Actions
Copy link

github-actions bot commented May 2, 2025

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@github-actions GitHub Actions
Copy link

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

@GutoVeronezi
Copy link
Contributor

Interesting feature, @shwstppr. I have not checked the code yet and perhaps you already addressed that, but the feature will be available only for root admins, right?

@shwstppr
Copy link
Contributor Author

@GutoVeronezi I've added role access for the API that creates the websocket endpoint, https://github.com/apache/cloudstack/pull/10758/files#diff-927a5c1f575fdc21fae04477b5df98e431353a755fda6b9f5ae27175f907a4eeR47, but I'm looking into more ways to control & secure the access.
Also, just a note, this is still very much in the design-development phase, so many things may change, or it may not even materialise.

@shwstppr
wip
70c0f71 
Signed-off-by: Abhishek Kumar <[email protected]>
@shwstppr
Copy link
Contributor Author

Closing this for now. Will revisit later.

@shwstppr shwstppr closed this May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bernardodemarco bernardodemarco Awaiting requested review from bernardodemarco

Assignees
No one assigned
Labels
component:api component:build status:needs-work
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shwstppr @GutoVeronezi